DataStream | Subscriptions tab

The Subscriptions tab lists all of your data subscriptions. Ayla's DataStream Service (DSS) enables customers to create, update, or delete subscriptions for data that occurs in the Ayla Platform with RESTful APIs.

NOTE

You can configure Role Based Access Controls (RBAC) to restrict the data that is transmitted externally to partners. For more information on DSS refer to the Ayla Single Sign-On (SSO) Guide (AY006USS6-2) on on Ayla Connection.

The following information is provided for each subscription:

  • Status:
    • Red (the subscription has stopped)
    • Green (the subscription is active)
    • Grey (the subscription is created but not started)
  • ID - Ayla-assigned ID for the Access Rule
  • OEM - Ayla-assigned OEM ID name
  • Name - the name of the subscription
  • Description - key point(s) about the subscription
  • Stream Key - the connection key for a stream to connect with the external servers
  • Client Type:
  • Cloud
  • user_opt_in
  • Subscription Type
  • datapoint
  • datapointack (available for generic gateway and Linux Whitebox)
  • connectivity
  • registration
  • location (provides LAT(latitude), LONG (longitude) during display-mode registration events)
  • Actions - Trash Can icon to delete the subscription

You can accomplish the following from the DataStream page:

ClosedCreate subscriptions

  1. Click the CREATE SUBCRIPTION button to open the Create Subscription dialog box, shown below:

  1. Edit the fields on the Details tab as follows:

  1. For Name, enter a name for the subscription.
  1. For Description, enter key point(s) about the subscription.
  2. For Model, enter the model number of the customer’s host application board.
  3. For DSN, enter the customer Device Serial Number; you can use a wild card.
  4. For Property Name, enter the name of property; you can use a wild card.
  5. For Client Type, select either of the following options from the drop-down list:
  • cloud
  • user_opt_in
  1. For Subscription Type, select one of the following options from the drop-down list:
  • datapoint
  • datapointack - available for Ayla Dynamic Gateway Agent (formerly called Generic Gateway) and Ayla Linux Agent (also called Linux Whitebox)
  • connectivity
  • registration
  • location - provides LAT(latitude), LONG (longitude) during display-mode registration events.
  1. Click CREATE.
ClosedReview additional details for existing subscriptions

  1. Click the subscription you wish to review. This opens the Subscription Details dialog box, shown below:

  1. Review the information.

  1. Click CLOSE.
ClosedDelete a subscription
  1. Click the Trash Can icon under Actions for the subscription you wish to delete.
  1. Click ACCEPT in the Confirmation dialog box:

 

 

 

See also: DataStream, DataStream Access Rules, Create Access Rules, DataStream Subscription Logs

How to get here on the dashboard: Click DataStream in the Navigation Panel.

Please click here to let us know how we're doing. Thank you.